HR - Employees - REST API

This operation allows to retrieve compensation data from CIM (HR data hub containing compensation data updated into Taliris) with a pagination mechanism.

REQUEST

url: /rest/v1/hr/compensationReview

Headers

The table below provide the details of the headers to be used when making the request.

Query Parameters

The table below provide the details of the query parameters that can be used when to query the webservice.

RESPONSE

Here is the format of the expected response

{
    "header": {
        "apiName": "{name of the DALI API processing the request}",
        "apiVersion": "{version of the DALI API processing the request}",
        "correlationId": "{correlationId generated by DALI conveyed all along the transaction}"
    },
    "data": {
        "payrollRespRubricList": [
            {
                "employeeErpId": "{Id of the employee}",
                "idRoc": "{Id of the employee in ROC}",
                "osmoseCode": "{company code in the ROC where employee is found}",
                "periodicity": "{Frequency of the series}",
                "amount": "{amount of the payment rubric}",
                "topRubric": "{payroll section}",
                "updateDate": "{modification date}",
                "effectiveDate": "{effective date}"
            }
        ],
        "payrollRespPromList": [
            {
                "employeeErpId": "{Id of the employee}",
                "idRoc": "{Id of the employee in ROC}",
                "osmoseCode": "{company code in the ROC where employee is found}",
                "effectiveDate": "{effective date}"
                "promotion": "{promotion type}",
                "promotionValue": "{promotion value}",
                "updateDate": "{modification date}",
            }
        ]
    },
    "links": {
        "selfRef": "{link to the requested page}",
        "firstRef": "{link to the first page}",
        "previousRef": "{link to the previous page}",
        "nextRef": "{link to the next page}",
        "lastRef": "{link to the last page}"
    },
    "limit": {number of rows returned per page},
    "currentPage": {current page number},
    "totalPages": {total number of pages}
}

MAPPING

Here are further information on each field in the response: